/*
 *  Copyright (C) 2010 Glauco
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.balisunrise.common;

import java.lang.reflect.Method;

/**
 * Esta Inteface representa uma columa do modelo do Grid.
 * @author Glauco
 * @version 1.0
 */
public interface GridColumn extends Basic{

    /**
     * Retorna o nome (Título) da columna.
     */
    public String getColumnName();

    /**
     * Retorna a classe da coluna, a qual é a classe do atributo da entidade que a
     * coluna representa.
     */
    public Class getColumnClass();

    /**
     * Retorna se é possível editar a coluna.
     */
    public boolean isColumnEditable();

    /**
     * Retorna o largura que a representação visual da coluna do Grid deve ter.
     */
    public int getWidth();

    /**
     * Retorna o valor contido no atributo do modelo (Entidade, source) para ser
     * exibido na coluna do Grid.
     *
     * @param source
     */
    public Object getValue(Object source);

    /**
     * Atribui do valor da coluna do Grid ao atribuito do modelo (Entidade, source).
     *
     * @param value
     * @param source
     */
    public void setValue(Object value, Object source);

    /**
     * Retorna um array com os métodos (java.lang.reflect.Method) que devem ser
     * chamados para ler o atributo da coluna.<br>
     * Estes métodos são utilizados no caso dos atributos que deve ser mostrados no
     * grid estiverem encapsulados em outros objetos que não sejam a propria entidade
     * (modelo, source).
     */
    public Method[] getCalls();

    /**
     * Atribui um método (java.lang.reflect.Method) que devem ser chamados para
     * ler o atributo da coluna.<br>
     * Estes métodos são utilizados no caso dos atributos que deve ser mostrados
     * no grid estiverem encapsulados em outros objetos que não sejam a propria
     * entidade (modelo, source).
     *
     * @param method
     */
    public void addCalls(Method method);

}